feat(paper): add dialog documentation about tags and nbt payloads#702
feat(paper): add dialog documentation about tags and nbt payloads#702samuelh2005 wants to merge 3 commits intoPaperMC:mainfrom
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
zlataovce
left a comment
zlataovce
left a comment
There was a problem hiding this comment.
looks good apart from a couple of nitpicks
zlataovce
added
dev guide
| } | ||
| ``` | ||
|
|
||
| ### Pause Screen Additions and Quick Actions |
There was a problem hiding this comment.
iirc we intentionally not documented that because the tag lifecycle event was not documented in the registries page.
There was a problem hiding this comment.
iirc we intentionally not documented that because the tag lifecycle event was not documented in the registries page.
What would the recommend alternative be?
There was a problem hiding this comment.
It's as Lulu said. Dialog tag key modification stuff is purposefully not documented on this page due to no companion page explaining the concept in-detail being present yet. This would be added as soon as the tag flatten events are documented properly.
Please remove this section for now.
Strokkur424
left a comment
Strokkur424
left a comment
There was a problem hiding this comment.
LGTM once you remove the dialog registry key addition section, which will be added at a later time, as explained in my review comment.
4 participants
This pull request adds new documentation explaining how to use dialog tags for pause screen and quick actions integration, and introduces a new section on using NBT payloads with dialogs in the API. The changes provide detailed code examples and best practices for both registering dialogs with special tags and handling custom NBT data using the
adventure-nbtlibrary.Dialog Tag Registration Enhancements:
PAUSE_SCREEN_ADDITIONSandQUICK_ACTIONSto integrate custom dialogs into the game's pause screen and quick actions menu, including a full code example for registering these tags in a plugin bootstrapper.NBT Payload Support for Dialogs:
PlayerCustomClickEvent.adventure-nbtlibrary, including exception handling and dependency notes.BinaryTagHoldertoCompoundBinaryTagand handling potential nulls and IO exceptions.